home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / INIFile.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  5KB  |  200 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // inifile.h
  5. //
  6. // API for the package INIFile.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /flux/packages/INIFile.h 5     11/06/00 11:24 Derekm $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(INIFile);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "inifile" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24.  
  25. #else
  26.  
  27. // declare handle type for INIFile handles
  28. handle hinifile : hobject;
  29.  
  30. //
  31. // hinifile INIFile.Cast( hobject h )
  32. //
  33. // Cast function
  34. //
  35. prototype hinifile INIFile.Cast( hobject h );
  36.  
  37. //
  38. // hinifile INIFile.Create( string filename )
  39. //
  40. // Create an INIFile object around the INI file.
  41. //
  42. prototype hinifile INIFile.Create( string filename );
  43.  
  44. //
  45. // INIFile.Destroy( hinifile handle )
  46. //
  47. // Destroys an INIFile object
  48. //
  49. prototype INIFile.Destroy( hinifile h );
  50.  
  51. //
  52. // String INIFile.String( hinifile handle, string section, string key,
  53. //                          string default )
  54. //
  55. // Get the string value from the given INI file member.
  56. //
  57. prototype string INIFile.String( hinifile h,
  58.                                  string section, 
  59.                                  string key,
  60.                                  string defaultstring );
  61.  
  62. //
  63. // String INIFile.NumberedString( hinifile handle, string section, string key,
  64. //                                  int number, string default )
  65. //
  66. // Get the string value from the given INI file member.
  67. //
  68. prototype string INIFile.NumberedString( hinifile h,
  69.                                          string section, 
  70.                                          string key,
  71.                                          int number,
  72.                                          string defaultstring );
  73.  
  74. //
  75. // int INIFile.Int( hinifile handle, string section, string key, int default )
  76. //
  77. // Get the int value from the given INI file member.
  78. //
  79. prototype int INIFile.Int( hinifile h,
  80.                            string section, 
  81.                            string key,
  82.                            int defaultint );
  83.  
  84. //
  85. // int INIFile.NumberedInt( hinifile handle, string section, string key,
  86. //                            int number, int default )
  87. //
  88. // Get the int value from the given INI file member.
  89. //
  90. prototype int INIFile.NumberedInt( hinifile h,
  91.                                    string section, 
  92.                                    string key,
  93.                                    int number,
  94.                                    int defaultint );
  95.  
  96. //
  97. // float INIFile.Float( hinifile handle, string section, string key,
  98. //                        float default )
  99. //
  100. // Get the float value from the given INI file member.
  101. //
  102. prototype float INIFile.Float( hinifile h,
  103.                                string section, 
  104.                                string key,
  105.                                float defaultfloat );
  106.  
  107. //
  108. // float INIFile.NumberedFloat( hinifile handle, string section, string key,
  109. //                                int number, float default )
  110. //
  111. // Get the float value from the given INI file member.
  112. //
  113. prototype float INIFile.NumberedFloat( hinifile h,
  114.                                        string section, 
  115.                                        string key,
  116.                                        int number,
  117.                                        float defaultfloat );
  118.  
  119. //
  120. // float INIFile.VectorX( hinifile handle, string section, string key )
  121. //
  122. // Get the x component of the vector value from the given INI file member.
  123. //
  124. prototype float INIFile.VectorX( hinifile h,
  125.                                  string section, 
  126.                                  string key );
  127.  
  128. //
  129. // float INIFile.VectorY( hinifile handle, string section, string key )
  130. //
  131. // Get the y component of the vector value from the given INI file member.
  132. //
  133. prototype float INIFile.VectorY( hinifile h,
  134.                                  string section, 
  135.                                  string key );
  136.  
  137. //
  138. // float INIFile.VectorZ( hinifile handle, string section, string key )
  139. //
  140. // Get the z component of the vector value from the given INI file member.
  141. //
  142. prototype float INIFile.VectorZ( hinifile h,
  143.                                  string section, 
  144.                                  string key );
  145.  
  146. //
  147. // float INIFile.NumberedVectorX( hinifile handle, string section, string key,
  148. //                                  int number )
  149. //
  150. // Get the x component of the vector value from the given INI file member.
  151. //
  152. prototype float INIFile.NumberedVectorX( hinifile h,
  153.                                          string section, 
  154.                                          string key,
  155.                                          int number );
  156.  
  157. //
  158. // float INIFile.NumberedVectorY( hinifile handle, string section, string key,
  159. //                                  int number )
  160. //
  161. // Get the y component of the vector value from the given INI file member.
  162. //
  163. prototype float INIFile.NumberedVectorY( hinifile h,
  164.                                          string section, 
  165.                                          string key,
  166.                                          int number );
  167.  
  168. //
  169. // float INIFile.NumberedVectorZ( hinifile handle, string section, string key,
  170. //                                  int number )
  171. //
  172. // Get the z component of the vector value from the given INI file member.
  173. //
  174. prototype float INIFile.NumberedVectorZ( hinifile h,
  175.                                          string section, 
  176.                                          string key,
  177.                                          int number );
  178.  
  179. //
  180. // bool INIFile.Exists( hinifile handle, string section, string key )
  181. //
  182. // Tests whether or not a given section and key exists 
  183. //
  184. prototype bool INIFile.Exists( hinifile h,
  185.                                string section,
  186.                                string key );
  187.  
  188. //
  189. // bool INIFile.NumberedExists( hinifile handle, string section, string key,
  190. //                                int number )
  191. //
  192. // Tests whether or not a given section and numbered key exists 
  193. //
  194. prototype bool INIFile.NumberedExists( hinifile h,
  195.                                        string section,
  196.                                        string key,
  197.                                        int number );
  198.  
  199. #endif // FLUX_LIB
  200.